PAN-2158: Adding OpenAPI docs generation #143
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Ticket contains a json if you would like to see how ot looks |
danut13
previously approved these changes
Nov 11, 2024
openapi.py
Outdated
| data.pop('swagger') | ||
| data['servers'] = [{'url': 'https://sn1.testnet.pantos.io'}] | ||
|
|
||
| with open("openapi.json", "w") as f: |
There was a problem hiding this comment.
This should be a parameter
. Or at least be dumped to a docs folder
There was a problem hiding this comment.
I did both - default goes to docs folder and added a parameter in case you want to have it somewhere else.
juanmanuel-tirado
approved these changes
Nov 12, 2024
danut13
approved these changes
Nov 12, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What type of PR is this? (check all applicable)
Description
Adding the possibility to generate openapi documentation for the Service Node Rest API endpoints.
Related Tickets & Documents
QA Instructions
Please replace this line with instructions on how to test your changes.
[optional] Are there any post deployment tasks we need to perform?